home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 5 / Apprentice-Release5.iso / Source Code / C / Applications / Python 1.3.3 / Python 133 68K / Demo / www / TEXI-HTML < prev    next >
Text File  |  1996-05-20  |  3KB  |  75 lines
  1. Converting Texinfo files into HTML
  2. ==================================
  3.  
  4.  
  5. Advantages of HTML over Info
  6. ----------------------------
  7.  
  8. Info files are ASCII only; HTML can display text in different fonts
  9. and sizes (if the output device is capable of doing so).
  10.  
  11. HTML can be browsed remotely and referenced by hyperlinks from other
  12. places in the World-Wide Web.
  13.  
  14.  
  15. Problems with using HTML for Texinfo files
  16. ------------------------------------------
  17.  
  18. Texinfo uses various highlighting commands, e.g.  @emph{text in
  19. italics}, @strong{text in bold} or @code{text in fixed-width font} and
  20. even @sc{text in small caps}.  It translates these to font changes in
  21. the printed manual, and to various forms of quotation marks and/or
  22. upper case in the Info files.  Since the generated HTML will be
  23. browsed both in ASCII mode and in multi-font mode, it is desirable
  24. that tags are put in the HTML files which correspond roughly with the
  25. tags used in Texinfo.  This means that the WWW browsers must be
  26. changed to recognize these new tags and interpret them accordingly.
  27.  
  28. Texinfo examples can still contain @-commands, e.g. to put comments in
  29. a non-fixed width font.
  30.  
  31. Texinfo has names for a (small) number of non-ASCII characters, e.g.
  32. @bullet{} and @equiv{}, which are again displayed different in ASCII
  33. mode than in the printed manual.
  34.  
  35. Texinfo has some list styles which do not closely map to HTML list
  36. styles.
  37.  
  38. Texinfo has some styles for which there is no HTML equivalent, e.g.
  39. "@quotation ... @end quotation" adds left and right indents to the
  40. contained text.
  41.  
  42. Texinfo allows the author more precise control over spacing between
  43. paragraphs and whether the first line of a paragraph should be
  44. indented.
  45.  
  46.  
  47. Goals
  48. -----
  49.  
  50. The primary goal is to be able to convert Texinfo files to HTML for
  51. browsing with WWW browsers; updates will be made to the Texinfo source
  52. files.
  53.  
  54. Eventually, it may be desirable to edit the resulting HTML instead
  55. (since it is more likely that WYSIWYG editors will exist for HTML than
  56. for Texinfo).  This would require that (almost) all Texinfo commands
  57. (and some lay-out features of the source as well!) are translated into
  58. distinch HTML tags, lest information be lost.  Ideally, it should be
  59. possible to write a program that translates HTML back into Texinfo
  60. without loss of information.
  61.  
  62.  
  63. Suggested changes to HTML
  64. -------------------------
  65.  
  66. Add '&name.' entities for the special characters used in Texinfo.
  67.  
  68. Support tags like <CODE>some text</CODE> which is expanded to `some
  69. text' in ASCII mode but uses a fixed-width font in multi-font mode,
  70. and <VAR>name</VAR> which uses italics or upper case.
  71.  
  72. Create a new form of example tag which produces a fixed-width font and
  73. breaks lines as in the source but does not suppress recognition of
  74. other tags.
  75.